/*
 * Copyright 2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.moduliths.docs;

import capital.scalable.restdocs.javadoc.JavadocReader;
import capital.scalable.restdocs.javadoc.JavadocReaderImpl;

import java.util.Optional;

import com.tngtech.archunit.core.domain.JavaMethod;

/**
 * A {@link DocumentationSource} that uses metadata generated by Spring Auto REST Docs' Javadoc Doclet.
 *
 * @author Oliver Drotbohm
 * @since 1.1
 */
class SpringAutoRestDocsDocumentationSource implements DocumentationSource {

	private final JavadocReader reader = JavadocReaderImpl.createWithSystemProperty();

	/*
	 * (non-Javadoc)
	 * @see org.moduliths.docs.JavadocSource#getDocumentation(com.tngtech.archunit.core.domain.JavaMethod)
	 */
	@Override
	public Optional<String> getDocumentation(JavaMethod method) {
		return Optional.of(reader.resolveMethodComment(method.getOwner().reflect(), method.getName()))
				.filter(it -> !it.isEmpty());
	}
}
